boost12 2.2.0
Loading...
Searching...
No Matches
boost12.h File Reference

This file contains API for Boost 12 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures

struct  boost12_t
 Boost 12 Click context object. More...
struct  boost12_cfg_t
 Boost 12 Click configuration object. More...

Macros

#define BOOST12_DEF_PWM_FREQ   5000
 Boost 12 default PWM frequency and duty cycle.
#define BOOST12_DEF_PWM_DC   0.0
#define BOOST12_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  boost12_return_value_t { BOOST12_OK = 0 , BOOST12_ERROR = -1 }
 Boost 12 Click return value data. More...

Functions

void boost12_cfg_setup (boost12_cfg_t *cfg)
 Boost 12 configuration object setup function.
err_t boost12_init (boost12_t *ctx, boost12_cfg_t *cfg)
 Boost 12 initialization function.
err_t boost12_default_cfg (boost12_t *ctx)
 Boost 12 default configuration function.
err_t boost12_set_duty_cycle (boost12_t *ctx, float duty_cycle)
 Boost 12 sets PWM duty cycle.
err_t boost12_pwm_stop (boost12_t *ctx)
 Boost 12 stop PWM module.
err_t boost12_pwm_start (boost12_t *ctx)
 Boost 12 start PWM module.

Detailed Description

This file contains API for Boost 12 Click Driver.

Enumeration Type Documentation

◆ boost12_return_value_t

Boost 12 Click return value data.

Predefined enum values for driver return values.

Enumerator
BOOST12_OK 
BOOST12_ERROR